Luna For Reddit
by Nathan tech
------------
Contents:
1. About the program.
2. An explanation of the home screen.
3. Settings and customisations.
4. A list of keystrokes that you'll want to know.
5. An important note about program behaviour.
6. Contact, credits and feedback.
------------
1. About the program.
Luna For Reddit is the windows client for Reddit that aims to make all sections of the platform as accessible as possible. Covering as much as the API that is supported by Reddit themselves, the program brings speed and simplicity to the Reddit interface, making it far more usable by screen reader users.
It's fast, it's simple and it works.
Reddit is a very popular social media platform and there's no reason screen reader users shouldn't be able to access it as fast as their sighted counterparts.
Luna For Reddit takes things a step further though, coming built in with keystrokes that speed up your experience, a spell checker and more!
------------
2. An explanation of the home screen.
When you launch Luna For Reddit, you will be shown the accounts screen. You can press tab to get to the add button and the other functions of the screen.
If you wish to rename or delete an account, tab to the "Open accounts Folder" button then change the file names or delete them as you like.
Once signed in, you will be presented with two lists, you can tab between them.
The first list is your home list and can be customised how you like from the settings screen.
Below is a list of items that may appear on the home screen:
1. My Profile: view your profile details. Press tab on this screen to get to your submissions, your upvoted posts, your saved posts and the close button.
2. Inbox: View, delete and send private messages.
3. Front Page: this is equivalent to the home feed of Reddit and contains a breakdown of your subscriptions and their top posts.
4. Friends: Use this list to jump straight to any of your friend's profiles, from which you can perform various actions such as sending them a message, viewing their submissions, blocking them and so on.
5. My Subscriptions: This will bring up a list of the subreddits that you have subscribed too.
6. subreddits: Search for subredits, view popular subreddits, create a new subreddit, view the subreddits you moderate and more.
7. Redditors: Search for people of Reddit with this option, allowing you to view their profile and more.
8. R/All: R/All is technically not a real subreddit, but instead it is an amalgamation of everything on Reddit.
9. Global Search: this is a search done on R/All.
10. your submissions: A shortcut to view your submissions.
11. your upvoted posts: A shortcut to jump straight to your upvoted posts.
12. Your saved posts: Jump straight to a list of posts that you have saved.
13. Program Settings: Change how Luna For Reddit works for you.
14. Web Preferences: This screen allows you to change many of the settings that affect the Reddit website itself and how it works for you. Not all of these relate to Luna For Reddit itself however, so you may find you never need it. That being said I put it in because, well, I needed it so you might!
15. Paste post link: found a post on Reddit? This will let you jump straight to it in Luna.
16. Learn Sounds: Learn the sounds of your selected pack and what they mean.
17. Logout: Logs you out of your account and returns you to the account screen.
Important: Not all of these items will show the first time you run Luna For Reddit, some are hidden. You can unhide them, or choose a new layout, by going to the Program Settings option.

the second list on the home screen is called "your stream."
This will contain a list that will constantly update as things come in of new messages, new comments on your posts and new posts in your subscriptions. You can customise what subscriptions the stream looks at in Program Settings.
------------
3. Settings and customisations.
If you open up the Program Settings item of the home list you will discover all the ways that Luna For Reddit can be made to work for you.
you cycle through the settings with your tab key which from left to right are explained below:
*Soundpack: Choose what sounds the program plays or create your own pack! If you want to create your own pack, simply create a new folder in the sounds/packs folder from where ever you installed or run Luna For Reddit. After that, add ogg files to it with names that match those in the default pack. Once done, let me know via email and i might be able to get your pack added in a future update!
*Volume: control how loud in app sounds play.
*Enable translated markdown: When checked, this will translate the markdown of Reddit into text, for example, instead of seeing:
 # This is a heading.
It will be changed to:
 heading level 1 This is a heading.
*subreddits on stream: This is where you can select which of your subscriptions you would like to appear in your stream. Use your arrow keys to navigate through the list and the enter key to toggle.
*Home list layout: This functions rather like the above item, but allows you to toggle what appears on your home list. Toggle items by pressing enter. Reorder the items by holding down control and pressing up arrow to move an item up, and down arrow to move an item down.
*Spellcheck dictionary: change what language dictionary is used by the program.
*Enable spell checking as you type: If enabled, this will play a sound when you make a typing mistake.
*post name format: Customise how you would like your posts to be displayed in lists. You can use the following substitutions:
%flair: The posts's flair.
%aflair: The author's flair.
%author: The author of the post.
%title: the title of the post.
%postdate: the date the post was submitted.
%numcomments: the number of comments on the post.
%votes: the number of upvotes the post has.
%a_flair: Author flair text.
%status: Whether the post is stickied or locked.
%distinguished: If the post has a distinguished setting, for example, has been marked by a moderator or admin.
%distinguished1:  Same as distinguished, but will only show the first letter. For example, if a post has been distinguished by a moderator, %distinguished will show the word moderator, %distinguished1 will show just m.

By default, the post format is %flair %title by %author, meaning that Luna For Reddit will show the flair, followed by the title, the word by, then the author of the post.
*comment format: Similar to the above, but instead for comments. Substitutions thate are supported:
%author: the author.
%aflair: The author's flair.
%comment: the comment body.
%votes: the number of upvotes it has.
%author: the author of the post.
%numreplies: the number of replies that the comment has.
%a_flair: Author flair text.
%distinguished: If the comment has a distinguished setting, for example, has been marked by a moderator or admin.
%distinguished1:  Same as distinguished, but will only show the first letter. For example, if a comment has been distinguished by a moderator, %distinguished will show the word moderator, %distinguished1 will show just m.
Default: %author - %comment
*Always show Sticky posts at the top: For certain sort options on Reddit, sticky posts are not included or may not be at the top of the list. Enabling this fixes that.
*Default sort mode for submissions: choose which of the sort modes Luna For Reddit uses by default.
*Save and close: does as you would expect.
Please note: If you make significant changes to the stream options, Luna may freeze for a few moments while it fetches your new data.
------------
4. A list of keystrokes that you'll want to know.
Fundamentally, using your arrow keys and the tab key will get you around 90 percent of the interface for Luna For Reddit.
From the home screen, pressing 1 to 0 while holding alt will activate items 1 through 10 of your home list.
subreddit lists and submission lists you can press your applications key, or shift f10, to bring up a list of options such as reporting, subscribing and such. This context menu is dynamic and different things will appear based on if you are a moderator, if you are the person who posted the item and such.
Note: If you are a moderator, an additional button will appear for the moderation screen, accessible if you hit shift tab from the post list.
When viewing lists of submissions, press control up arrow to upvote a post, control down arrow to downvote the post and control backspace to clear your vote. If it is your post, press the delete key to delete it. Press Alt N to write a new post and Alt S to do a search.
When viewing posts, press H to cycle through headings, Shift H to go backwards. Press L to do the same for lists and K for links. You can also press Q to scroll by block quote, or the numbers 1 through 7 to go by heading level. Finally, to refresh the post, press f5.
When viewing comments, press control up arrow to upvote, control down arrow to downvote, and control backspace to clear your vote. Just like with submissions, press delete to delete your comment and the applications key to view more options.
When viewing posts or comments, press control 1 to control 7 to hear pieces of information about the post or comment. Press it twice to copy the information to the clipboard.
If the comment is too long for the treeview, or you wish to read it more in depth, press enter to bring up a text box containing the comment.
Further, if the item is called "More comments." press enter on it to get Luna to load more comments. You can also press control semicolon to jump up to the previous comment that is a route comment, control dot to jump to the next route comment, control slash to expand all replies, and control comma to collapse all replies.
By route comment, we mean a comment on the post, rather than a comment of a comment of a comment.
When writing posts or messages, press the applications key, or shift f10, to bring up a list of insertable items, such as headings or links. Luna For Reddit will handle the markdown for you. You can also press your applications key on a word that is not spelled correctly and Luna will offer you the chance to correct it. Finally, press f7 to run the spell checker.
to write a new comment, hit control N. To reply to a comment, it's control R. To report a comment, press Control T.
You can hit escape on most screens to close them.
Hit Control H anywhere to minimise the window to the system tray.
------------
5. An important note about program behaviour.
When Luna For Reddit performs certain network heavy tasks, I.E, when it is fetching a lot of content from reddit, it does this in a way that is designed to not block the program.
In Version 1, Luna would fetch the content, and display it to you in one go, this meant however that the program could freeze if fetching a lot of data. When Luna froze, it had a tendancy to freeze screen readers with it which, for good reason, got a lot of complaints.
As such the program now does not e freeze, but you may have to wait a couple of seconds while it loads the requested content.
For example, if you load up a subreddit, you may at first only see an option to go back in the list. If you wait a couple of moments though, the list will very quickly fill up with items. Consider this like a web page loading your content.
------------
6. Contact, credits and feedback.
Luna For Reddit, while coded by me, has many people to thank for its existance:
PRAW: This project made Luna For Reddit happen a lot quicker than it otherwise would have.
Kerry Hoath: for providing some coins so that Awarding could be tested.
Simon: For invaluable testing, suggestions and great conversations and fantastic advice.
My twitter followers and the people who dropped mentions: For giving me great advice and the knowledge that this will actually help!
To get in touch or to provide feedback, head over to the contact form on the website:
https://nathantech.net/contact.php
------------
End of Readme.
Readme last updated: March 12th 2022.
Nathan Tech.
It's not disability.
It's ability!